Fix User-Agent when OSDescription has unmatched parenthesis #4991
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
donnie-msft
previously approved these changes
Dec 28, 2022
| { | ||
| var target = new UserAgentStringBuilder(); | ||
|
|
||
| var result = target.WithOSDescription(osDescription).Build(); |
erdembayar
previously approved these changes
Jan 3, 2023
zivkan
force-pushed
the
dev-zivkan-http-user-agent-invalid-format
branch
from
85dc801 to
468f603
Compare
erdembayar
approved these changes
Jan 6, 2023
donnie-msft
approved these changes
Jan 7, 2023
|
I requeued failed test, now it's green. |
zivkan
added a commit
that referenced
this pull request
Jan 19, 2023
8 tasks
jebriede
pushed a commit
that referenced
this pull request
Jan 19, 2023
jeffkl
added a commit
that referenced
this pull request
Jan 31, 2023
aortiz-msft
pushed a commit
that referenced
this pull request
Jan 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug
Fixes: NuGet/Home#11995
Regression? Last working version:
Description
HTTP header syntax has a section/token/syntax called
comment, which is surrounded by parenthesis, but the comment itself can have a nested comment. In other words, the opening and closing parenthesis must be balanced.Since we pass
RuntimeInformation.OSDescriptionas a comment in NuGet'sUser-Agentheader, we need to sanitize the input (escape the parenthesis), just in case it has unbalanced parenthesis. Even when they are balanced, NuGet isn't using it to provide a comment on the rest of the string, so I believe it's valid to always escape them.PR Checklist
PR has a meaningful title
PR has a linked issue.
Described changes
Tests
Documentation